home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / tden_30.zip / TEXTDOOR.DOC < prev    next >
Text File  |  1991-02-15  |  10KB  |  305 lines
  1.  
  2.  
  3.                  -=( LiveSystems TextDoor )=-
  4.  
  5.  
  6.       What is it?
  7.  
  8.       TextDoor is an utility which enables users to read ascii
  9.       textfiles online, and to view ansi files. You can group
  10.       files in submenus somewhat the same way ms-dos does with
  11.       it's directories. It's desqview aware and can be used in a
  12.       multiline environment.
  13.  
  14.       Warning: This program only works under Remote Access! It
  15.                needs the Config.RA file.
  16.  
  17.       Disclaimer.
  18.  
  19.       Don't make me laugh...;) Use it at your own risk. It's
  20.       reasonal well tested, I use it myself, but that's it! Oh
  21.       well, I wouldn't release a program that's not up to my idea
  22.       of good software. (At the moment I release it, that is.
  23.       Things change and bugs appear from no-where....;) Anyhow, no
  24.       guarantees what so ever.
  25.  
  26.       Money.
  27.  
  28.       Well, what to say about money.. There is a start, one
  29.       registration for VoteDoor!! But still... If you like this
  30.       program and continue to use it, I would appriciate it if you
  31.       would donate some money to rebuild my trust in humanity...
  32.       Let's say $5 or f10,- when you keep on using this program..
  33.  
  34.                       Giro 1806776 (for the dutch ppl)
  35.  
  36.                       Gerhard Hoogterp
  37.                       Kremersmaten 108
  38.                       7511 LC Enschede
  39.                       Holland.
  40.  
  41.       For burning questions, remarks and wishes you can reach me
  42.       on fidonet as
  43.  
  44.                       Gerhard Hoogterp @ 2:283/1.2
  45.                       or on BitNet as HOOGTERPG@HENUT5
  46.  
  47.       What wishes concern, no guarantees they are implemented, but
  48.       who knows....
  49.  
  50.       All my programs are requestable and downloadable at the LiveSystems
  51.       support board:
  52.  
  53.       Actionboard Alphen,
  54.       Sysop Bart Burkles
  55.       01720-37926
  56.       2:281/604
  57.  
  58.       You can also drop questions and remarks here.
  59.  
  60.        Installation in RA.
  61.  
  62.  
  63.       The TextDoor is easy to install in RemoteAccess. You just
  64.       make a type 7 Menu entry in some menu and use the line:
  65.  
  66.       c:\TextDoor\TextDoor.exe -T:*T [-N:*N] [-P:*P] [-S:OFF]
  67.  
  68.       as commandline. TextDoor will use the startup directory as
  69.       it's home directory where it expects to find it's
  70.       configuration and submenu files. (In the line above the
  71.       directory 'C:\TextDoor' is used as the home directory)
  72.       You can override the startup directory with the environment
  73.       variable 'TEXTDOOR'. If it's available, the directory it
  74.       points to is used as homedirectory.
  75.  
  76.       The Optional -S:Off parameter turns the use of sound on the
  77.       local screen off.
  78.  
  79.       After you made the menuentry you should make at least the
  80.       top menu. This menu is the same as the configuration file.
  81.  
  82.        Setting up the textlibrary.
  83.  
  84.       TextDoor expects to find a file named 'TEXTDOOR.CFG' in it's
  85.       home directory.  It's the main list of readable files and
  86.       the configuration file at the same time. This goes for all
  87.       the submenu files too by the way.
  88.  
  89.       There are two reserved words in a menu/configuration file:
  90.  
  91.                       %TxtPath <Path>
  92.  
  93.       Where path is the path to the directory where the
  94.       readable/viewable files are stored. This keyword may be used
  95.       not only in the main menu file but also in all the submenu
  96.       files so you can group files not only logical but also
  97.       physical. The keyword MUST be the first line in the file.
  98.  
  99.  
  100.                       %Title <Title>
  101.  
  102.       Default, textdoor takes the description of the entry from
  103.       where the submenu was called as title, but if you like the
  104.       header to say something else here's how.
  105.  
  106.       The reminder of the file is used for the list of viewable
  107.       files. These have the form:
  108.  
  109.                       <FileName> <Type> <Description>
  110.  
  111.       F.e.:
  112.  
  113.       Humor.Txt       N       Jokes and funny stories
  114.       TextDoor.Inf    N       Info on the TextDoor program
  115.       AnsiMenu.Lst    !       Ansi screens to view
  116.       Shuttle.ans     A       Demonstration file of TheDraw.
  117.  
  118.       The filename is a normal ms-dos filename without path. It
  119.       may also contain wildcard. In this case the first match will
  120.       be used.
  121.  
  122.       There are three types of files at this moment:
  123.  
  124.       Type │ Description   │ Directory
  125.       ─────┼───────────────┼─────────────
  126.        N   │ Normal ascii  │ %TxtPath
  127.        A   │ ANSI/AVATAR   │ %TxtPath
  128.        !   │ Submenu       │ HomeDir
  129.  
  130.       N: Normal flat ascii file. Can be read by anyone.
  131.       A: ANSI/AVATAR file, can only be viewed by users who have the
  132.          ansi and/or AVATAR toggle on.
  133.       S: SubMenu. Reads the file as if it was a configuration
  134.          file. This file is expected to be found in the HomeDir!
  135.  
  136.       %TxtPath directory is the directory which is defined by the
  137.       last %TxtPath keyword (Not necessarily in the current menu
  138.       file)
  139.  
  140.       HomeDir is the startup directory.
  141.  
  142.        Security:
  143.  
  144.  
  145.       SecurityLevel:
  146.  
  147.  
  148.       You can make menu items invisable for certain groups of users.
  149.       When a filename starts with 'SEC' it is checked for a security
  150.       level between the 'SEC' and the '.' The item will only be
  151.       available for users with that security and higher. Handy to
  152.       read your logfiles f.e.
  153.  
  154.       Examples:
  155.  
  156.         SECURITY.TXT N Text about security and computers
  157.         SEC1000.LST  ! Helpfiles for co-sysops.
  158.  
  159.       The first line is available to every user who has access to the
  160.       textdoor program, the second item (a submenu) is only available
  161.       for users with security level 1000 and higher.
  162.  
  163.  
  164.       Flags:
  165.  
  166.       It's also possible to make an item only available to users who
  167.       have a certain flag set. When a filename starts with 'FLAG'
  168.       TextDoor checks for a legal flag directly after the 'FLAG'
  169.  
  170.       A legal flag is formed by: [A..D][1..8]
  171.  
  172.       Examples:
  173.  
  174.         FLAGS.TXT   ! View the flags of the world in technoansi.
  175.         FLAGA1.LST  ! Only for Hackers Inc.
  176.         FLAGD4T.LST ! registered users only.
  177.  
  178.  
  179.       The first menu is accessable by anyone, the second only for
  180.       users with the A1 flag set, and the thirth only for users
  181.       with the D4 flag set. Only one flag can be used...
  182.  
  183.  
  184.       This whole system is WYSIWYG, if an entry isn't accessable by a
  185.       user he doesn't see it.. prevents questions and such..;-)
  186.  
  187.        An Example:
  188.  
  189.       In the HomeDir (\TextDoor) are the files:
  190.  
  191.       TextDoor.Exe            Main program
  192.       TextDoor.Cfg            MainMenu/configuration file
  193.       Humor.Lst               A submenu file
  194.       Info.lst                An other SubMenu file
  195.       Ansi.lst                An Submenu file with Ansi viewable files.
  196.       SEC32000.Lst            A submenu for the sysop.
  197.  
  198.       Further there are 3 extra directories:
  199.  
  200.       \TextDoor\Humor
  201.       \TextDoor\Info
  202.       \TextDoor\Ansi
  203.  
  204.       which contain the actual files to view.
  205.  
  206.  
  207.  
  208.       Here are the menu files:
  209.  
  210.       TextDoor.Cfg:
  211.  
  212.       %TxtPath \TextDoor
  213.       ;
  214.       ; Only Submenus
  215.       ;
  216.       Info.lst     !     Information about this bulletinboard
  217.       Humor.lst    !     Humorous texts
  218.       Ansi.lst     !     Ansi files to view
  219.  
  220.  
  221.       Info.lst:
  222.  
  223.       %TxtFile \TextDoor\info
  224.       ;
  225.       ;  Information about the BBS
  226.       ;
  227.       TextDoor.Cfg   !    Back to the main menu
  228.       Echomail.txt   N    Echomail, what & how
  229.       Rules.txt      N    Rules of this BBS
  230.       Email.txt      N    How to use Email
  231.       BBSlijst.*     N    Latest BBSlijst
  232.  
  233.       Humor.Lst:
  234.  
  235.       %TxtFile \TextDoor\Humor
  236.       ;
  237.       ; Humor and jokes menu
  238.       ;
  239.       TextDoor.Cfg   !    Back to the main menu
  240.       NutWorks.001   N    Nutworks January
  241.       NutWorks.002   N    Nutworks February
  242.       
  243.       Ansi.lst:
  244.  
  245.       %TxtPath \TextDoor\Ansi
  246.       ;
  247.       ; Ansi Files
  248.       ;
  249.       Ansi.inf       N   How to get YOUR ansi screen here..
  250.       Shuttle.ans    A   Animated demo of a shuttle.
  251.  
  252.  
  253.       Sec32000.lst
  254.  
  255.       %TxtPath \ra
  256.       %Title  Sysops Den
  257.       ;
  258.       ; Logfiles
  259.       ;
  260.       TextDoor.Cfg   !  Let's go back
  261.       RA.Log         N  RA Logfile
  262.       Upload.log     N  Uploaded files
  263.       Download.log   N  Downloaded files
  264.       PRVFiles.log   N  Private to the sysop
  265.  
  266.       As you see YOU are responsible for a way back. There's no
  267.       menu stack as in RA, You can jump around as you like..
  268.  
  269.        Other info.
  270.  
  271.       *  TextDoor detects when DesqView is used. It gives back
  272.          timeslices whenever it's waiting for a key or when the
  273.          fossil outputbuffer is full.
  274.  
  275.       *  TextDoor also looks for on-line messages. Whenever one is
  276.          found, it's contents is shown to the user in TextDoor.
  277.  
  278.       *  You can make into and goodbye screens for TextDoor if you
  279.          like. When there's a
  280.  
  281.              TDHI. asc/ans
  282.  
  283.          it's shown to the user before he enters the main menu.
  284.  
  285.              TDBye. ans/asc
  286.  
  287.           is shown after he leaves the program.
  288.  
  289.       *  TextDoor writes major errors and logon/logoff info to the
  290.          RA logfile which is defined in the Config.ra. At this
  291.          moment only the FrontDoor type logging is supported.
  292.          Whatever you select in the config file..
  293.  
  294.       *  Ansi is handled internally for the local console. There's
  295.          no need for a separated ansi driver. Also is the monomode
  296.          toggle of RA recognized.
  297.  
  298.       *  For the user, all the computer related info from the
  299.          userrecord is used. TextDoor adjusts itself to the wishes
  300.          of the user.
  301.  
  302.       *  There's a limit of 500 entries per menufile.
  303.  
  304.       
  305.